<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.freedesktop.UDisks2.Drive: UDisks Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="UDisks Reference Manual">
<link rel="up" href="ch02.html" title="D-Bus Interfaces">
<link rel="prev" href="gdbus-org.freedesktop.UDisks2.Manager.html" title="org.freedesktop.UDisks2.Manager">
<link rel="next" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html" title="org.freedesktop.UDisks2.Drive.Ata">
<meta name="generator" content="GTK-Doc V1.29 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gdbus-org.freedesktop.UDisks2.Drive.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#gdbus-org.freedesktop.UDisks2.Drive.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gdbus-org.freedesktop.UDisks2.Manager.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gdbus-org.freedesktop.UDisks2.Drive"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-Drive.top_of_page"></a>org.freedesktop.UDisks2.Drive</span></h2>
<p>org.freedesktop.UDisks2.Drive — Disk drives</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Methods</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-method-org-freedesktop-UDisks2-Drive.Eject" title="The Eject() method">Eject</a>            (IN  a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-method-org-freedesktop-UDisks2-Drive.SetConfiguration" title="The SetConfiguration() method">SetConfiguration</a> (IN  a{sv} value,
                  IN  a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-method-org-freedesktop-UDisks2-Drive.PowerOff" title="The PowerOff() method">PowerOff</a>         (IN  a{sv} options);
</pre>
</div>
<div class="refsect1">
<a name="id-1.3.3.3.4"></a><h2>Properties</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Vendor" title='The "Vendor" property'>Vendor</a>                 readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Model" title='The "Model" property'>Model</a>                  readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Revision" title='The "Revision" property'>Revision</a>               readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Serial" title='The "Serial" property'>Serial</a>                 readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.WWN" title='The "WWN" property'>WWN</a>                    readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Id" title='The "Id" property'>Id</a>                     readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Configuration" title='The "Configuration" property'>Configuration</a>          readable   a{sv}
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Media" title='The "Media" property'>Media</a>                  readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.MediaCompatibility" title='The "MediaCompatibility" property'>MediaCompatibility</a>     readable   as
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.MediaRemovable" title='The "MediaRemovable" property'>MediaRemovable</a>         readable   b
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.MediaAvailable" title='The "MediaAvailable" property'>MediaAvailable</a>         readable   b
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.MediaChangeDetected" title='The "MediaChangeDetected" property'>MediaChangeDetected</a>    readable   b
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Size" title='The "Size" property'>Size</a>                   readable   t
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.TimeDetected" title='The "TimeDetected" property'>TimeDetected</a>           readable   t
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.TimeMediaDetected" title='The "TimeMediaDetected" property'>TimeMediaDetected</a>      readable   t
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Optical" title='The "Optical" property'>Optical</a>                readable   b
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.OpticalBlank" title='The "OpticalBlank" property'>OpticalBlank</a>           readable   b
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.OpticalNumTracks" title='The "OpticalNumTracks" property'>OpticalNumTracks</a>       readable   u
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.OpticalNumAudioTracks" title='The "OpticalNumAudioTracks" property'>OpticalNumAudioTracks</a>  readable   u
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.OpticalNumDataTracks" title='The "OpticalNumDataTracks" property'>OpticalNumDataTracks</a>   readable   u
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.OpticalNumSessions" title='The "OpticalNumSessions" property'>OpticalNumSessions</a>     readable   u
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.RotationRate" title='The "RotationRate" property'>RotationRate</a>           readable   i
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.ConnectionBus" title='The "ConnectionBus" property'>ConnectionBus</a>          readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Seat" title='The "Seat" property'>Seat</a>                   readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Removable" title='The "Removable" property'>Removable</a>              readable   b
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Ejectable" title='The "Ejectable" property'>Ejectable</a>              readable   b
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.SortKey" title='The "SortKey" property'>SortKey</a>                readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.CanPowerOff" title='The "CanPowerOff" property'>CanPowerOff</a>            readable   b
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.SiblingId" title='The "SiblingId" property'>SiblingId</a>              readable   s
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-org-freedesktop-UDisks2-Drive"></a><h2>Description</h2>
<p>      This interface is used to represent both hard disks and disk
      drives (with or without removable media).
</p>
<p>      This interface should not to be confused with the
      <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a> interface that is used for
      low-level block devices the OS knows about. For example, if
      <code class="filename">/dev/sda</code> and <code class="filename">/dev/sdb</code>
      are block devices for two paths to the same drive, there will be
      only one <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-interface-org-freedesktop-UDisks2-Drive.top_of_page">org.freedesktop.UDisks2.Drive</a> object but two
      <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a> objects.
</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-org.freedesktop.UDisks2.Drive"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Drive.Eject"></a><h3>The Eject() method</h3>
<pre class="programlisting">
Eject (IN  a{sv} options);
</pre>
<p>        Ejects media from the drive. This is only meaningful to do on
        drives with removable media.
</p>
<p>        There are not a lot of guarantees associated with this method
        so it should only be called in response to an user action.
</p>
<p>        On some hardware the media may be physically ejected while on
        other hardware may simply eject the disc. On some hardware it
        may not do anything physical but it may cause e.g. a display
        on the hardware to show e.g. <span class="quote">“<span class="quote">It is now safe to remove
        the device</span>”</span>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Drive.SetConfiguration"></a><h3>The SetConfiguration() method</h3>
<pre class="programlisting">
SetConfiguration (IN  a{sv} value,
                  IN  a{sv} options);
</pre>
<p>        Sets the configuration for the drive. This will store the
        configuration in the file-system and also apply it to the
        drive.
</p>
<p>        See the <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Configuration" title='The "Configuration" property'>"Configuration"</a> property
        for details about valid values and the location of the
        configuration file that <em class="parameter"><code>value</code></em> will be written to.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>value</code></em></code>:</span></p></td>
<td><p>The configuration value to set.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Drive.PowerOff"></a><h3>The PowerOff() method</h3>
<pre class="programlisting">
PowerOff (IN  a{sv} options);
</pre>
<p>        Arranges for the drive to be safely removed and powered
        off. On the OS side this includes ensuring that no process is
        using the drive, then requesting that in-flight buffers and
        caches are committed to stable storage. The exact steps for
        powering off the drive depends on the drive itself and the
        interconnect used. For drives connected through USB, the
        effect is that the USB device will be deconfigured followed by
        disabling the upstream hub port it is connected to.
</p>
<p>        Note that as some physical devices contain multiple drives
        (for example 4-in-1 flash card reader USB devices) powering
        off one drive may affect other drives. Applications can
        examine the <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.SiblingId" title='The "SiblingId" property'>"SiblingId"</a> property
        to determine such relationships.
</p>
<p>        There are not a lot of guarantees associated with this method
        so it should only be called in response to an user
        action. Usually the effect is that the drive disappears as if
        it was unplugged.
</p>
<p>        This method only works if the
        <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.CanPowerOff" title='The "CanPowerOff" property'>"CanPowerOff"</a> property
        is set to <code class="constant">TRUE</code>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr></tbody>
</table></div>
<p class="since">Since 2.0.0</p>
</div>
</div>
<div class="refsect1">
<a name="gdbus-properties-org.freedesktop.UDisks2.Drive"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Vendor"></a><h3>The "Vendor" property</h3>
<pre class="programlisting">
Vendor  readable   s
</pre>
<p>A name for the vendor of the drive or blank if unknown.</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Model"></a><h3>The "Model" property</h3>
<pre class="programlisting">
Model  readable   s
</pre>
<p>A name for the model of the drive or blank if unknown.</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Revision"></a><h3>The "Revision" property</h3>
<pre class="programlisting">
Revision  readable   s
</pre>
<p>Firmware Revision or blank if unknown.</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Serial"></a><h3>The "Serial" property</h3>
<pre class="programlisting">
Serial  readable   s
</pre>
<p>Serial number of the drive or blank if unknown.</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.WWN"></a><h3>The "WWN" property</h3>
<pre class="programlisting">
WWN  readable   s
</pre>
<p>         The <a class="ulink" href="http://en.wikipedia.org/wiki/World_Wide_Name" target="_top">World Wide
         Name</a> of the drive or blank if unknown.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Id"></a><h3>The "Id" property</h3>
<pre class="programlisting">
Id  readable   s
</pre>
<p>         A unique and persistent identifier for the device or blank if
         no such identifier is available.
</p>
<p>         This identifier is guaranteed to not include the slash
         character '/' (U+002F SOLIDUS) which means it can be used as
         a filename.
</p>
<p>         Examples:
         <span class="quote">“<span class="quote">ST32000542AS-6XW00W51</span>”</span>,
         <span class="quote">“<span class="quote">HITACHI-HTS723232A7A364-E3834563KRG2HN</span>”</span>,
         <span class="quote">“<span class="quote">INTEL-SSDSA2MH080G1GC-CVEM842101HD080DGN</span>”</span>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Configuration"></a><h3>The "Configuration" property</h3>
<pre class="programlisting">
Configuration  readable   a{sv}
</pre>
<p>         A set of configuration directives that are applied to the
         drive when it is connected (e.g. at start-up, hotplug or
         resume).
</p>
<p>         This is an dict of items with the following known keys:
         </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">ata-pm-standby (type <code class="literal">'i'</code>)</span></p></td>
<td><p>
               The spindown timeout for ATA drives (See ATA command <span class="quote">“<span class="quote">STANDBY</span>”</span>).
             </p></td>
</tr>
<tr>
<td><p><span class="term">ata-apm-level (type <code class="literal">'i'</code>)</span></p></td>
<td><p>
               The APM level for ATA drives (See ATA command <span class="quote">“<span class="quote">SET FEATURES</span>”</span>, sub-commands 0x05 and 0x85).
             </p></td>
</tr>
<tr>
<td><p><span class="term">ata-aam-level (type <code class="literal">'i'</code>)</span></p></td>
<td><p>
               The AAM level for ATA drives (See ATA command <span class="quote">“<span class="quote">SET FEATURES</span>”</span>, sub-commands 0x42 and 0xc2).
             </p></td>
</tr>
<tr>
<td><p><span class="term">ata-write-cache-enabled (type <code class="literal">'b'</code>)</span></p></td>
<td><p>
               Whether the write-cache is enabled (See ATA command <span class="quote">“<span class="quote">SET FEATURES</span>”</span>, sub-commands 0x82 and 0x02). Since 2.1.
             </p></td>
</tr>
<tr>
<td><p><span class="term">ata-read-lookahead-enabled (type <code class="literal">'b'</code>)</span></p></td>
<td><p>
               Whether the read look-ahead is enabled (See ATA command <span class="quote">“<span class="quote">SET FEATURES</span>”</span>, sub-commands 0x55 and 0xaa). Since 2.1.7.
             </p></td>
</tr>
</tbody>
</table></div>
<p>
         The contents of this property is read from the configuration
         file <code class="filename">/etc/udisks2/IDENTIFIER.conf</code>
         where <span class="emphasis"><em>IDENTIFIER</em></span> is the value of the
         <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Id" title='The "Id" property'>"Id"</a> property. See <a class="xref" href="udisks.8.html" title="udisks"><span class="refentrytitle">udisks</span>(8)</a> for the file format of this file.
</p>
<p>         Use the <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-method-org-freedesktop-UDisks2-Drive.SetConfiguration" title="The SetConfiguration() method">SetConfiguration()</a>
         method to change the value of this property.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Media"></a><h3>The "Media" property</h3>
<pre class="programlisting">
Media  readable   s
</pre>
<p>The kind of media currently in the drive or blank if unknown.</p>
<p>         See the <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.MediaCompatibility" title='The "MediaCompatibility" property'>"MediaCompatibility"</a> property for known values.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.MediaCompatibility"></a><h3>The "MediaCompatibility" property</h3>
<pre class="programlisting">
MediaCompatibility  readable   as
</pre>
<p>      The physical kind of media the drive uses or the type of the drive or blank if unknown.
      Known values include
      </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">thumb</span></p></td>
<td><p>The device is a thumb-drive with non-removable media (e.g. a USB stick)</p></td>
</tr>
<tr>
<td><p><span class="term">flash</span></p></td>
<td><p>Flash Card</p></td>
</tr>
<tr>
<td><p><span class="term">flash_cf</span></p></td>
<td><p>CompactFlash</p></td>
</tr>
<tr>
<td><p><span class="term">flash_ms</span></p></td>
<td><p>MemoryStick</p></td>
</tr>
<tr>
<td><p><span class="term">flash_sm</span></p></td>
<td><p>SmartMedia</p></td>
</tr>
<tr>
<td><p><span class="term">flash_sd</span></p></td>
<td><p>Secure Digital</p></td>
</tr>
<tr>
<td><p><span class="term">flash_sdhc</span></p></td>
<td><p>Secure Digital High Capacity</p></td>
</tr>
<tr>
<td><p><span class="term">flash_sdxc</span></p></td>
<td><p>Secure Digital eXtended Capacity</p></td>
</tr>
<tr>
<td><p><span class="term">flash_mmc</span></p></td>
<td><p>MultiMediaCard</p></td>
</tr>
<tr>
<td><p><span class="term">floppy</span></p></td>
<td><p>Floppy Disk</p></td>
</tr>
<tr>
<td><p><span class="term">floppy_zip</span></p></td>
<td><p>Zip Disk</p></td>
</tr>
<tr>
<td><p><span class="term">floppy_jaz</span></p></td>
<td><p>Jaz Disk</p></td>
</tr>
<tr>
<td><p><span class="term">optical</span></p></td>
<td><p>Optical Disc</p></td>
</tr>
<tr>
<td><p><span class="term">optical_cd</span></p></td>
<td><p>Compact Disc</p></td>
</tr>
<tr>
<td><p><span class="term">optical_cd_r</span></p></td>
<td><p>Compact Disc Recordable</p></td>
</tr>
<tr>
<td><p><span class="term">optical_cd_rw</span></p></td>
<td><p>Compact Disc Rewritable</p></td>
</tr>
<tr>
<td><p><span class="term">optical_dvd</span></p></td>
<td><p>Digital Versatile Disc</p></td>
</tr>
<tr>
<td><p><span class="term">optical_dvd_r</span></p></td>
<td><p>DVD-R</p></td>
</tr>
<tr>
<td><p><span class="term">optical_dvd_rw</span></p></td>
<td><p>DVD-RW</p></td>
</tr>
<tr>
<td><p><span class="term">optical_dvd_ram</span></p></td>
<td><p>DVD-RAM</p></td>
</tr>
<tr>
<td><p><span class="term">optical_dvd_plus_r</span></p></td>
<td><p>DVD+R</p></td>
</tr>
<tr>
<td><p><span class="term">optical_dvd_plus_rw</span></p></td>
<td><p>DVD+RW</p></td>
</tr>
<tr>
<td><p><span class="term">optical_dvd_plus_r_dl</span></p></td>
<td><p>DVD+R Dual Layer</p></td>
</tr>
<tr>
<td><p><span class="term">optical_dvd_plus_rw_dl</span></p></td>
<td><p>DVD+RW Dual Layer</p></td>
</tr>
<tr>
<td><p><span class="term">optical_bd</span></p></td>
<td><p>Blu-ray Disc</p></td>
</tr>
<tr>
<td><p><span class="term">optical_bd_r</span></p></td>
<td><p>Blu-ray Recordable</p></td>
</tr>
<tr>
<td><p><span class="term">optical_bd_re</span></p></td>
<td><p>Blu-ray Rewritable</p></td>
</tr>
<tr>
<td><p><span class="term">optical_hddvd</span></p></td>
<td><p>HD-DVD</p></td>
</tr>
<tr>
<td><p><span class="term">optical_hddvd_r</span></p></td>
<td><p>HD-DVD Recordable</p></td>
</tr>
<tr>
<td><p><span class="term">optical_hddvd_rw</span></p></td>
<td><p>HD-DVD Rewritable</p></td>
</tr>
<tr>
<td><p><span class="term">optical_mo</span></p></td>
<td><p>Magneto Optical</p></td>
</tr>
<tr>
<td><p><span class="term">optical_mrw</span></p></td>
<td><p>Can read Mount Rainer media</p></td>
</tr>
<tr>
<td><p><span class="term">optical_mrw_w</span></p></td>
<td><p>Can write Mount Rainer media</p></td>
</tr>
</tbody>
</table></div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.MediaRemovable"></a><h3>The "MediaRemovable" property</h3>
<pre class="programlisting">
MediaRemovable  readable   b
</pre>
<p>         Whether the media can be removed from the drive.
</p>
<p>         Note that this may be overridden from what the hardware
         reports - for example, USB thumb drives often report that
         they are using removable media while in fact the media
         is not removable.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.MediaAvailable"></a><h3>The "MediaAvailable" property</h3>
<pre class="programlisting">
MediaAvailable  readable   b
</pre>
<p>Set to <code class="constant">FALSE</code> if no medium is available.</p>
<p>         This is always <code class="constant">TRUE</code> if <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.MediaChangeDetected" title='The "MediaChangeDetected" property'>"MediaChangeDetected"</a> is <code class="constant">FALSE</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.MediaChangeDetected"></a><h3>The "MediaChangeDetected" property</h3>
<pre class="programlisting">
MediaChangeDetected  readable   b
</pre>
<p>Set to <code class="constant">TRUE</code> only if media changes are detected.</p>
<p>         Media changes are detected on all modern disk drives through
         either polling or an asynchronous notification mechanism. The
         only known disk drives that cannot report media changes are
         PC floppy drives.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Size"></a><h3>The "Size" property</h3>
<pre class="programlisting">
Size  readable   t
</pre>
<p>The size of the drive (or the media currently in the drive).</p>
<p>         This is always 0 if <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.MediaChangeDetected" title='The "MediaChangeDetected" property'>"MediaChangeDetected"</a> is <code class="constant">FALSE</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.TimeDetected"></a><h3>The "TimeDetected" property</h3>
<pre class="programlisting">
TimeDetected  readable   t
</pre>
<p>The time the drive was first detected.</p>
<p>         This is expressed in micro-seconds since the Epoch Jan 1, 1970 0:00 UTC.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.TimeMediaDetected"></a><h3>The "TimeMediaDetected" property</h3>
<pre class="programlisting">
TimeMediaDetected  readable   t
</pre>
<p>The earliest time media was last detected or 0 if media is not available.</p>
<p>         This is expressed in micro-seconds since the Epoch Jan 1, 1970 0:00 UTC.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Optical"></a><h3>The "Optical" property</h3>
<pre class="programlisting">
Optical  readable   b
</pre>
<p><code class="constant">TRUE</code> if the drive contains an optical disc.</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.OpticalBlank"></a><h3>The "OpticalBlank" property</h3>
<pre class="programlisting">
OpticalBlank  readable   b
</pre>
<p><code class="constant">TRUE</code> if the disc is blank.</p>
<p>         This is only valid if the property <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Optical" title='The "Optical" property'>"Optical"</a> is <code class="constant">TRUE</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.OpticalNumTracks"></a><h3>The "OpticalNumTracks" property</h3>
<pre class="programlisting">
OpticalNumTracks  readable   u
</pre>
<p>The number of tracks.</p>
<p>         This is only valid if the property <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Optical" title='The "Optical" property'>"Optical"</a> is <code class="constant">TRUE</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.OpticalNumAudioTracks"></a><h3>The "OpticalNumAudioTracks" property</h3>
<pre class="programlisting">
OpticalNumAudioTracks  readable   u
</pre>
<p>The number of audio tracks.</p>
<p>         This is only valid if the property <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Optical" title='The "Optical" property'>"Optical"</a> is <code class="constant">TRUE</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.OpticalNumDataTracks"></a><h3>The "OpticalNumDataTracks" property</h3>
<pre class="programlisting">
OpticalNumDataTracks  readable   u
</pre>
<p>The number of data tracks.</p>
<p>         This is only valid if the property <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Optical" title='The "Optical" property'>"Optical"</a> is <code class="constant">TRUE</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.OpticalNumSessions"></a><h3>The "OpticalNumSessions" property</h3>
<pre class="programlisting">
OpticalNumSessions  readable   u
</pre>
<p>The number of sessions.</p>
<p>         This is only valid if the property <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Optical" title='The "Optical" property'>"Optical"</a> is <code class="constant">TRUE</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.RotationRate"></a><h3>The "RotationRate" property</h3>
<pre class="programlisting">
RotationRate  readable   i
</pre>
<p>The rotational rate of the drive.</p>
<p>      </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>-1 if known to be rotating media but rotation rate isn't known</p></li>
<li class="listitem"><p>0 if known to be non-rotating media</p></li>
<li class="listitem"><p>the rotation rate in rounds per minute otherwise</p></li>
</ul></div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.ConnectionBus"></a><h3>The "ConnectionBus" property</h3>
<pre class="programlisting">
ConnectionBus  readable   s
</pre>
<p>      The physical connection bus used for the drive as seen by the
      user. This is typically used to draw a USB or Firewire emblem
      on top of an icon in an user interface.
</p>
<p>      Note that this property has <span class="emphasis"><em>nothing</em></span> to do
      with the low-level command-set used (such as ATA-8) or what
      low-level connection bus (such as SATA, eSATA, PATA, SAS2 etc)
      is used.
</p>
<p>      Known values include:
      </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">usb</span></p></td>
<td><p>Connected via <a class="ulink" href="http://en.wikipedia.org/wiki/USB" target="_top">USB</a></p></td>
</tr>
<tr>
<td><p><span class="term">sdio</span></p></td>
<td><p>Connected via <a class="ulink" href="http://en.wikipedia.org/wiki/Secure_Digital#SDIO" target="_top">SDIO</a></p></td>
</tr>
<tr>
<td><p><span class="term">ieee1394</span></p></td>
<td><p>Connected via <a class="ulink" href="http://en.wikipedia.org/wiki/Firewire" target="_top">Firewire</a></p></td>
</tr>
</tbody>
</table></div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Seat"></a><h3>The "Seat" property</h3>
<pre class="programlisting">
Seat  readable   s
</pre>
<p>         A string identifying what seat the drive is plugged into, if any.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Removable"></a><h3>The "Removable" property</h3>
<pre class="programlisting">
Removable  readable   b
</pre>
<p>        A hint whether the drive and/or its media is considered
        <span class="emphasis"><em>removable</em></span> by the user.
</p>
<p>        This includes drives with removable media (cf. the
        <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.MediaRemovable" title='The "MediaRemovable" property'>"MediaRemovable"</a> property), Flash
        media such as SD cards and drives on hotpluggable buses such
        as USB or Firewire (cf. the
        <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.ConnectionBus" title='The "ConnectionBus" property'>"ConnectionBus"</a> property).
</p>
<p>        Note that this is only a <span class="emphasis"><em>guess</em></span>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Ejectable"></a><h3>The "Ejectable" property</h3>
<pre class="programlisting">
Ejectable  readable   b
</pre>
<p>         Whether the media can be ejected from the drive or the drive
         accepts an eject command to switch its state so it displays
         e.g. a "Safe To Remove" message to the user.
</p>
<p>         Note that this is only a <span class="emphasis"><em>guess</em></span>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.SortKey"></a><h3>The "SortKey" property</h3>
<pre class="programlisting">
SortKey  readable   s
</pre>
<p>         A string that can be used for sorting drive objects.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.CanPowerOff"></a><h3>The "CanPowerOff" property</h3>
<pre class="programlisting">
CanPowerOff  readable   b
</pre>
<p>         Whether the drive can be safely removed / powered off. See
         the <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-method-org-freedesktop-UDisks2-Drive.PowerOff" title="The PowerOff() method">PowerOff()</a> method for more
         information.
</p>
<p>         See <a class="xref" href="udisks.8.html" title="udisks"><span class="refentrytitle">udisks</span>(8)</a> for how to influence the value of this property.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.SiblingId"></a><h3>The "SiblingId" property</h3>
<pre class="programlisting">
SiblingId  readable   s
</pre>
<p>         An opaque token that, if non-blank, is used to group drives
         that are part of the same physical device.
</p>
<p class="since">Since 2.0.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29</div>
</body>
</html>